Physics collision shape component. More...
#include <CollisionShape.h>
Inheritance diagram for Urho3D::CollisionShape:
Collaboration diagram for Urho3D::CollisionShape:
Public Member Functions | |
| CollisionShape (Context *context) | |
| Construct. | |
| virtual | ~CollisionShape () |
| Destruct. Free the geometry data and clean up unused data from the geometry data cache. | |
| virtual void | OnSetAttribute (const AttributeInfo &attr, const Variant &src) |
| Handle attribute write access. | |
| virtual void | ApplyAttributes () |
| Apply attribute changes that can not be applied immediately. Called after scene load or a network update. | |
| virtual void | OnSetEnabled () |
| Handle enabled/disabled state change. | |
| virtual void | DrawDebugGeometry (DebugRenderer *debug, bool depthTest) |
| Visualize the component as debug geometry. | |
| void | SetBox (const Vector3 &size, const Vector3 &position=Vector3::ZERO, const Quaternion &rotation=Quaternion::IDENTITY) |
| Set as a box. | |
| void | SetSphere (float diameter, const Vector3 &position=Vector3::ZERO, const Quaternion &rotation=Quaternion::IDENTITY) |
| Set as a sphere. | |
| void | SetStaticPlane (const Vector3 &position=Vector3::ZERO, const Quaternion &rotation=Quaternion::IDENTITY) |
| Set as a static plane. | |
| void | SetCylinder (float diameter, float height, const Vector3 &position=Vector3::ZERO, const Quaternion &rotation=Quaternion::IDENTITY) |
| Set as a cylinder. | |
| void | SetCapsule (float diameter, float height, const Vector3 &position=Vector3::ZERO, const Quaternion &rotation=Quaternion::IDENTITY) |
| Set as a capsule. | |
| void | SetCone (float diameter, float height, const Vector3 &position=Vector3::ZERO, const Quaternion &rotation=Quaternion::IDENTITY) |
| Set as a cone. | |
| void | SetTriangleMesh (Model *model, unsigned lodLevel=0, const Vector3 &scale=Vector3::ONE, const Vector3 &position=Vector3::ZERO, const Quaternion &rotation=Quaternion::IDENTITY) |
| Set as a triangle mesh from Model. If you update a model's geometry and want to reapply the shape, call physicsWorld->RemoveCachedGeometry(model) first. | |
| void | SetCustomTriangleMesh (CustomGeometry *custom, const Vector3 &scale=Vector3::ONE, const Vector3 &position=Vector3::ZERO, const Quaternion &rotation=Quaternion::IDENTITY) |
| Set as a triangle mesh from CustomGeometry. | |
| void | SetConvexHull (Model *model, unsigned lodLevel=0, const Vector3 &scale=Vector3::ONE, const Vector3 &position=Vector3::ZERO, const Quaternion &rotation=Quaternion::IDENTITY) |
| Set as a convex hull from Model. | |
| void | SetCustomConvexHull (CustomGeometry *custom, const Vector3 &scale=Vector3::ONE, const Vector3 &position=Vector3::ZERO, const Quaternion &rotation=Quaternion::IDENTITY) |
| Set as a convex hull from CustomGeometry. | |
| void | SetTerrain (unsigned lodLevel=0) |
| Set as a terrain. Only works if the same scene node contains a Terrain component. | |
| void | SetShapeType (ShapeType type) |
| Set shape type. | |
| void | SetSize (const Vector3 &size) |
| Set shape size. | |
| void | SetPosition (const Vector3 &position) |
| Set offset position. | |
| void | SetRotation (const Quaternion &rotation) |
| Set offset rotation. | |
| void | SetTransform (const Vector3 &position, const Quaternion &rotation) |
| Set offset transform. | |
| void | SetMargin (float margin) |
| Set collision margin. | |
| void | SetModel (Model *model) |
| Set triangle mesh / convex hull model. | |
| void | SetLodLevel (unsigned lodLevel) |
| Set model LOD level. | |
| btCollisionShape * | GetCollisionShape () const |
| Return Bullet collision shape. | |
| CollisionGeometryData * | GetGeometryData () const |
| Return the shared geometry data. | |
| PhysicsWorld * | GetPhysicsWorld () const |
| Return physics world. | |
| ShapeType | GetShapeType () const |
| Return shape type. | |
| const Vector3 & | GetSize () const |
| Return shape size. | |
| const Vector3 & | GetPosition () const |
| Return offset position. | |
| const Quaternion & | GetRotation () const |
| Return offset rotation. | |
| float | GetMargin () const |
| Return collision margin. | |
| Model * | GetModel () const |
| Return triangle mesh / convex hull model. | |
| unsigned | GetLodLevel () const |
| Return model LOD level. | |
| BoundingBox | GetWorldBoundingBox () const |
| Return world-space bounding box. | |
| void | NotifyRigidBody (bool updateMass=true) |
| Update the new collision shape to the RigidBody. | |
| void | SetModelAttr (const ResourceRef &value) |
| Set model attribute. | |
| ResourceRef | GetModelAttr () const |
| Return model attribute. | |
| void | ReleaseShape () |
| Release the collision shape. | |
 Public Member Functions inherited from Urho3D::Component | |
| Component (Context *context) | |
| Construct. | |
| virtual | ~Component () |
| Destruct. | |
| virtual bool | Save (Serializer &dest) const |
| Save as binary data. Return true if successful. | |
| virtual bool | SaveXML (XMLElement &dest) const |
| Save as XML data. Return true if successful. | |
| virtual void | MarkNetworkUpdate () |
| Mark for attribute check on the next network update. | |
| virtual void | GetDependencyNodes (PODVector< Node * > &dest) |
| Return the depended on nodes to order network updates. | |
| void | SetEnabled (bool enable) |
| Set enabled/disabled state. | |
| void | Remove () |
| Remove from the scene node. If no other shared pointer references exist, causes immediate deletion. | |
| unsigned | GetID () const |
| Return ID. | |
| Node * | GetNode () const |
| Return scene node. | |
| Scene * | GetScene () const |
| Return the scene the node belongs to. | |
| bool | IsEnabled () const |
| Return whether is enabled. | |
| bool | IsEnabledEffective () const |
| Return whether is effectively enabled (node is also enabled.) | |
| Component * | GetComponent (StringHash type) const |
| Return component in the same scene node by type. If there are several, returns the first. | |
| void | GetComponents (PODVector< Component * > &dest, StringHash type) const |
| Return components in the same scene node by type. | |
| template<class T > | |
| T * | GetComponent () const |
| Template version of returning a component in the same scene node by type. | |
| template<class T > | |
| void | GetComponents (PODVector< T * > &dest) const |
| Template version of returning components in the same scene node by type. | |
| void | AddReplicationState (ComponentReplicationState *state) |
| Add a replication state that is tracking this component. | |
| void | PrepareNetworkUpdate () |
| Prepare network update by comparing attributes and marking replication states dirty as necessary. | |
| void | CleanupConnection (Connection *connection) |
| Clean up all references to a network connection that is about to be removed. | |
| Public Member Functions inherited from Urho3D::Animatable | |
| Animatable (Context *context) | |
| Construct. | |
| virtual | ~Animatable () |
| Destruct. | |
| virtual bool | LoadXML (const XMLElement &source, bool setInstanceDefault=false) |
| Load from XML data. When setInstanceDefault is set to true, after setting the attribute value, store the value as instance's default value. Return true if successful. | |
| void | SetAnimationEnabled (bool enable) |
| Set automatic update of animation, default true. | |
| void | SetAnimationTime (float time) |
| Set time position of all attribute animations or an object animation manually. Automatic update should be disabled in this case. | |
| void | SetObjectAnimation (ObjectAnimation *objectAnimation) |
| Set object animation. | |
| void | SetAttributeAnimation (const String &name, ValueAnimation *attributeAnimation, WrapMode wrapMode=WM_LOOP, float speed=1.0f) |
| Set attribute animation. | |
| void | SetAttributeAnimationWrapMode (const String &name, WrapMode wrapMode) |
| Set attribute animation wrap mode. | |
| void | SetAttributeAnimationSpeed (const String &name, float speed) |
| Set attribute animation speed. | |
| void | SetAttributeAnimationTime (const String &name, float time) |
| Set attribute animation time position manually. Automatic update should be disabled in this case. | |
| void | RemoveObjectAnimation () |
| Remove object animation. Same as calling SetObjectAnimation with a null pointer. | |
| void | RemoveAttributeAnimation (const String &name) |
| Remove attribute animation. Same as calling SetAttributeAnimation with a null pointer. | |
| bool | GetAnimationEnabled () const |
| Return animation enabled. | |
| ObjectAnimation * | GetObjectAnimation () const |
| Return object animation. | |
| ValueAnimation * | GetAttributeAnimation (const String &name) const |
| Return attribute animation. | |
| WrapMode | GetAttributeAnimationWrapMode (const String &name) const |
| Return attribute animation wrap mode. | |
| float | GetAttributeAnimationSpeed (const String &name) const |
| Return attribute animation speed. | |
| float | GetAttributeAnimationTime (const String &name) const |
| Return attribute animation time position. | |
| void | SetObjectAnimationAttr (const ResourceRef &value) |
| Set object animation attribute. | |
| ResourceRef | GetObjectAnimationAttr () const |
| Return object animation attribute. | |
| Public Member Functions inherited from Urho3D::Serializable | |
| Serializable (Context *context) | |
| Construct. | |
| virtual | ~Serializable () |
| Destruct. | |
| virtual void | OnGetAttribute (const AttributeInfo &attr, Variant &dest) const |
| Handle attribute read access. Default implementation reads the variable at offset, or invokes the get accessor. | |
|
virtual const Vector < AttributeInfo > * | GetAttributes () const |
| Return attribute descriptions, or null if none defined. | |
|
virtual const Vector < AttributeInfo > * | GetNetworkAttributes () const |
| Return network replication attribute descriptions, or null if none defined. | |
| virtual bool | Load (Deserializer &source, bool setInstanceDefault=false) |
| Load from binary data. When setInstanceDefault is set to true, after setting the attribute value, store the value as instance's default value. Return true if successful. | |
| virtual bool | SaveDefaultAttributes () const |
| Return whether should save default-valued attributes into XML. Default false. | |
| bool | SetAttribute (unsigned index, const Variant &value) |
| Set attribute by index. Return true if successfully set. | |
| bool | SetAttribute (const String &name, const Variant &value) |
| Set attribute by name. Return true if successfully set. | |
| void | ResetToDefault () |
| Reset all editable attributes to their default values. | |
| void | RemoveInstanceDefault () |
| Remove instance's default values if they are set previously. | |
| void | SetTemporary (bool enable) |
| Set temporary flag. Temporary objects will not be saved. | |
| void | SetInterceptNetworkUpdate (const String &attributeName, bool enable) |
| Enable interception of an attribute from network updates. Intercepted attributes are sent as events instead of applying directly. This can be used to implement client side prediction. | |
| void | AllocateNetworkState () |
| Allocate network attribute state. | |
| void | WriteInitialDeltaUpdate (Serializer &dest, unsigned char timeStamp) |
| Write initial delta network update. | |
| void | WriteDeltaUpdate (Serializer &dest, const DirtyBits &attributeBits, unsigned char timeStamp) |
| Write a delta network update according to dirty attribute bits. | |
| void | WriteLatestDataUpdate (Serializer &dest, unsigned char timeStamp) |
| Write a latest data network update. | |
| bool | ReadDeltaUpdate (Deserializer &source) |
| Read and apply a network delta update. Return true if attributes were changed. | |
| bool | ReadLatestDataUpdate (Deserializer &source) |
| Read and apply a network latest data update. Return true if attributes were changed. | |
| Variant | GetAttribute (unsigned index) const |
| Return attribute value by index. Return empty if illegal index. | |
| Variant | GetAttribute (const String &name) const |
| Return attribute value by name. Return empty if not found. | |
| Variant | GetAttributeDefault (unsigned index) const |
| Return attribute default value by index. Return empty if illegal index. | |
| Variant | GetAttributeDefault (const String &name) const |
| Return attribute default value by name. Return empty if not found. | |
| unsigned | GetNumAttributes () const |
| Return number of attributes. | |
| unsigned | GetNumNetworkAttributes () const |
| Return number of network replication attributes. | |
| bool | IsTemporary () const |
| Return whether is temporary. | |
| bool | GetInterceptNetworkUpdate (const String &attributeName) const |
| Return whether an attribute's network updates are being intercepted. | |
| NetworkState * | GetNetworkState () const |
| Return the network attribute state, if allocated. | |
| Public Member Functions inherited from Urho3D::Object | |
| Object (Context *context) | |
| Construct. | |
| virtual | ~Object () |
| Destruct. Clean up self from event sender & receiver structures. | |
| virtual StringHash | GetType () const =0 |
| Return type hash. | |
| virtual const String & | GetTypeName () const =0 |
| Return type name. | |
| virtual const TypeInfo * | GetTypeInfo () const =0 |
| Return type info. | |
| virtual void | OnEvent (Object *sender, StringHash eventType, VariantMap &eventData) |
| Handle event. | |
| bool | IsInstanceOf (StringHash type) const |
| Check current instance is type of specified type. | |
| bool | IsInstanceOf (const TypeInfo *typeInfo) const |
| Check current instance is type of specified type. | |
| template<typename T > | |
| bool | IsInstanceOf () const |
| Check current instance is type of specified class. | |
| void | SubscribeToEvent (StringHash eventType, EventHandler *handler) |
| Subscribe to an event that can be sent by any sender. | |
| void | SubscribeToEvent (Object *sender, StringHash eventType, EventHandler *handler) |
| Subscribe to a specific sender's event. | |
| void | UnsubscribeFromEvent (StringHash eventType) |
| Unsubscribe from an event. | |
| void | UnsubscribeFromEvent (Object *sender, StringHash eventType) |
| Unsubscribe from a specific sender's event. | |
| void | UnsubscribeFromEvents (Object *sender) |
| Unsubscribe from a specific sender's events. | |
| void | UnsubscribeFromAllEvents () |
| Unsubscribe from all events. | |
| void | UnsubscribeFromAllEventsExcept (const PODVector< StringHash > &exceptions, bool onlyUserData) |
| Unsubscribe from all events except those listed, and optionally only those with userdata (script registered events.) | |
| void | SendEvent (StringHash eventType) |
| Send event to all subscribers. | |
| void | SendEvent (StringHash eventType, VariantMap &eventData) |
| Send event with parameters to all subscribers. More... | |
| VariantMap & | GetEventDataMap () const |
| Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps. | |
| Context * | GetContext () const |
| Return execution context. | |
| Object * | GetSubsystem (StringHash type) const |
| Return subsystem by type. | |
| Object * | GetEventSender () const |
| Return active event sender. Null outside event handling. | |
| EventHandler * | GetEventHandler () const |
| Return active event handler. Null outside event handling. | |
| bool | HasSubscribedToEvent (StringHash eventType) const |
| Return whether has subscribed to an event without specific sender. | |
| bool | HasSubscribedToEvent (Object *sender, StringHash eventType) const |
| Return whether has subscribed to a specific sender's event. | |
| bool | HasEventHandlers () const |
| Return whether has subscribed to any event. | |
| template<class T > | |
| T * | GetSubsystem () const |
| Template version of returning a subsystem. | |
| const String & | GetCategory () const |
| Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered. | |
| Public Member Functions inherited from Urho3D::RefCounted | |
| RefCounted () | |
| Construct. Allocate the reference count structure and set an initial self weak reference. | |
| virtual | ~RefCounted () |
| Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist. | |
| void | AddRef () |
| Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting. | |
| void | ReleaseRef () |
| Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting. | |
| int | Refs () const |
| Return reference count. | |
| int | WeakRefs () const |
| Return weak reference count. | |
| RefCount * | RefCountPtr () |
| Return pointer to the reference count structure. | |
Static Public Member Functions | |
| static void | RegisterObject (Context *context) |
| Register object factory. | |
Protected Member Functions | |
| virtual void | OnNodeSet (Node *node) |
| Handle node being assigned. | |
| virtual void | OnSceneSet (Scene *scene) |
| Handle scene being assigned. | |
| virtual void | OnMarkedDirty (Node *node) |
| Handle node transform being dirtied. | |
| Protected Member Functions inherited from Urho3D::Component | |
| virtual void | OnAttributeAnimationAdded () |
| Handle attribute animation added. | |
| virtual void | OnAttributeAnimationRemoved () |
| Handle attribute animation removed. | |
| virtual void | OnNodeSetEnabled (Node *node) |
| Handle scene node enabled status changing. | |
| void | SetID (unsigned id) |
| Set ID. Called by Scene. | |
| void | SetNode (Node *node) |
| Set scene node. Called by Node when creating the component. | |
| void | HandleAttributeAnimationUpdate (StringHash eventType, VariantMap &eventData) |
| Handle scene attribute animation update event. | |
| Protected Member Functions inherited from Urho3D::Animatable | |
| virtual Animatable * | FindAttributeAnimationTarget (const String &name, String &outName) |
| Find target of an attribute animation from object hierarchy by name. | |
| void | SetObjectAttributeAnimation (const String &name, ValueAnimation *attributeAnimation, WrapMode wrapMode, float speed) |
| Set object attribute animation internal. | |
| void | OnObjectAnimationAdded (ObjectAnimation *objectAnimation) |
| Handle object animation added. | |
| void | OnObjectAnimationRemoved (ObjectAnimation *objectAnimation) |
| Handle object animation removed. | |
| void | UpdateAttributeAnimations (float timeStep) |
| Update attribute animations. | |
| bool | IsAnimatedNetworkAttribute (const AttributeInfo &attrInfo) const |
| Is animated network attribute. | |
| AttributeAnimationInfo * | GetAttributeAnimationInfo (const String &name) const |
| Return attribute animation info. | |
| void | HandleAttributeAnimationAdded (StringHash eventType, VariantMap &eventData) |
| Handle attribute animation added. | |
| void | HandleAttributeAnimationRemoved (StringHash eventType, VariantMap &eventData) |
| Handle attribute animation removed. | |
Private Member Functions | |
| URHO3D_OBJECT (CollisionShape, Component) | |
| btCompoundShape * | GetParentCompoundShape () |
| Find the parent rigid body component and return its compound collision shape. | |
| void | UpdateShape () |
| Update the collision shape after attribute changes. | |
| void | HandleTerrainCreated (StringHash eventType, VariantMap &eventData) |
| Update terrain collision shape from the terrain component. | |
| void | HandleModelReloadFinished (StringHash eventType, VariantMap &eventData) |
| Update trimesh or convex shape after a model has reloaded itself. | |
Private Attributes | |
| WeakPtr< PhysicsWorld > | physicsWorld_ |
| Physics world. | |
| WeakPtr< RigidBody > | rigidBody_ |
| Rigid body. | |
| SharedPtr< Model > | model_ |
| Model. | |
| SharedPtr< CollisionGeometryData > | geometry_ |
| Shared geometry data. | |
| btCollisionShape * | shape_ |
| Bullet collision shape. | |
| ShapeType | shapeType_ |
| Collision shape type. | |
| Vector3 | position_ |
| Offset position. | |
| Quaternion | rotation_ |
| Offset rotation. | |
| Vector3 | size_ |
| Shape size. | |
| Vector3 | cachedWorldScale_ |
| Cached world scale for determining if the collision shape needs update. | |
| unsigned | lodLevel_ |
| Model LOD level. | |
| unsigned | customGeometryID_ |
| CustomGeometry component ID. 0 if not creating the convex hull / triangle mesh from a CustomGeometry. | |
| float | margin_ |
| Collision margin. | |
| bool | recreateShape_ |
| Recreate collision shape flag. | |
| bool | retryCreation_ |
| Shape creation retry flag if attributes initially set without scene. | |
Additional Inherited Members | |
| Protected Attributes inherited from Urho3D::Component | |
| Node * | node_ |
| Scene node. | |
| unsigned | id_ |
| Unique ID within the scene. | |
| bool | networkUpdate_ |
| Network update queued flag. | |
| bool | enabled_ |
| Enabled flag. | |
Detailed Description
Physics collision shape component.
The documentation for this class was generated from the following files:
- /home/travis/build/urho3d/Urho3D/Source/Urho3D/Physics/CollisionShape.h
- /home/travis/build/urho3d/Urho3D/Source/Urho3D/Physics/CollisionShape.cpp
